docs/Global Functions.md

   1 # Global Functions
   2
   3 _Global Functions_ (abbr. GF) are a mechanism allowing to override certain flight parameters (during flight). Global Functions are activated by [Logic Conditions](Logic%20Conditions.md)
   4
   5 ## CLI
   6
   7 `gf <rule> <enabled> <logic condition> <action> <operand type> <operand value> <flags>`
   8
   9 * `<rule>` - GF ID, indexed from `0`
  10 * `<enabled>` - `0` evaluates as disabled, `1` evaluates as enabled. Only enabled GFs are executed
  11 * `<logic condition>` - the ID of _LogicCondition_ used to trigger GF On/Off. Then LC evaluates `true`, GlobalFunction will be come active
  12 * `<action>` - action to execute when GF is active
  13 * `<operand type>` - allows to pass arguments into Global Function action. Syntax is the same as in case of Logic Conditions operands. Used only when `action` requires it. Should be kept at `0` in other case. See [Logic Conditions](Logic%20Conditions.md)
  14 * `<operand value>` - allows to pass arguments into Global Function action. Syntax is the same as in case of Logic Conditions operands. Used only when `action` requires it. Should be kept at `0` in other case. See [Logic Conditions](Logic%20Conditions.md)
  15 * `<flags>` - allows to pass arguments into Global Function action. Syntax is the same as in case of Logic Conditions operands
  16
  17 ## Actions
  18
  19 | Action ID     | Name                          | Notes                                 |
  20 |----           |----                           |----                                   |
  21 | 0             | OVERRIDE_ARMING_SAFETY        | Allows to arm on any angle even without GPS fix              |
  22 | 1             | OVERRIDE_THROTTLE_SCALE       | Override throttle scale to the value defined by operand. Operand type `0` and value `50` means throttle will be scaled by 50%. |
  23 | 2             | SWAP_ROLL_YAW                 | basically, when activated, yaw stick will control roll and roll stick will control yaw. Required for tail-sitters VTOL during vertical-horizonral transition when body frame changes |
  24 | 3             | SET_VTX_POWER_LEVEL           | Sets VTX power level. Accepted values are `0-3` for SmartAudio and `0-4` for Tramp protocol |
  25 | 4             | INVERT_ROLL                   | Inverts ROLL axis input for PID/PIFF controller |
  26 | 5             | INVERT_PITCH                  | Inverts PITCH axis input for PID/PIFF controller  |
  27 | 6             | INVERT_YAW                    | Inverts YAW axis input for PID/PIFF controller |
  28 | 7             | OVERRIDE_THROTTLE             | Override throttle value that is fed to the motors by mixer. Operand is scaled in us. `1000` means throttle cut, `1500` means half throttle |
  29 | 8             | SET_VTX_BAND           | Sets VTX band. Accepted values are `1-5` |
  30 | 8             | SET_VTX_CHANNEL           | Sets VTX channel. Accepted values are `1-8` |
  31
  32 ## Flags
  33
  34 Current no flags are implemented
  35
  36 ## Example
  37
  38 ### Dynamic THROTTLE scale
  39
  40 `gf 0 1 0 1 0 50 0`
  41
  42 Limits the THROTTLE output to 50% when Logic Condition `0` evaluates as `true`
  43
  44 ### Set VTX power level via Smart Audio
  45
  46 `gf 0 1 0 3 0 3 0`
  47
  48 Sets VTX power level to `3` when Logic Condition `0` evaluates as `true`
  49
  50 ### Invert ROLL and PITCH when rear facing camera FPV is used
  51
  52 Solves the problem from [https://github.com/iNavFlight/inav/issues/4439](https://github.com/iNavFlight/inav/issues/4439)
  53
  54 ```
  55 gf 0 1 0 4 0 0 0
  56 gf 1 1 0 5 0 0 0
  57 ```
  58
  59 Inverts ROLL and PITCH input when Logic Condition `0` evaluates as `true`. Moving Pitch stick up will cause pitch down (up for rear facing camera). Moving Roll stick right will cause roll left of a quad (right in rear facing camera)
  60
  61 ### Cut motors but keep other throttle bindings active
  62
  63 `gf 0 1 0 7 0 1000 0`
  64
  65 Sets Thhrottle output to `0%` when Logic Condition `0` evaluates as `true`
  66
  67 ### Set throttle to 50% and keep other throttle bindings active
  68
  69 `gf 0 1 0 7 0 1500 0`
  70
  71 Sets Thhrottle output to about `50%` when Logic Condition `0` evaluates as `true`
  72
  73 ### Set throttle control to different RC channel
  74
  75 `gf 0 1 0 7 1 7 0`
  76
  77 If Logic Condition `0` evaluates as `true`, motor throttle control is bound to RC channel 7 instead of throttle channel
  78